MarkLogic 12 Product Documentation
GET /manage/v2/protected-collections?collection={collection-uri}

Summary

This resource address returns the configuration for the specified protected collection.

URL Parameters
collection	The URI of the protected collection.
format	The format of the returned data. Can be either `html`, `json`, or `xml` (default). This value overrides the Accept header if both are present.

Request Headers
Accept	The expected MIME type of the response. If the `format` parameter is present, it takes precedence over the Accept header.

Response Headers
Content-type	The MIME type of the data in the response body. Depending upon the value of the `format` parameter or Accept header, one of `application/xml`, `application/json`, or `text/html`.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires one of the following:

the manage-admin and security role
the following privileges:
http://marklogic.com/xdmp/privileges/manage

http://marklogic.com/xdmp/privileges/manage-admin

http://marklogic.com/xdmp/privileges/collection-get-permissions

Usage Notes

The structure of the output returned from this REST API is as follows:

collection

The collection uri.

permissions

The default set of permissions used in document creation.

This is a complex structure with the following children:

permission

Permission representation.